home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / groan11.zip / GROAN.DOC < prev    next >
Text File  |  1992-12-25  |  22KB  |  480 lines
  1.  
  2.                              GROAN    DICE
  3.  
  4.                                   v1.1
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    GROAN DIce is a fast-paced dice game played with 3  8-sided die. Each
  21.    die contains the normal 1-6 values plus a GROAN and a JACKPOT.
  22.  
  23.    The object of the game is to accumulate and save as many points as
  24.    possible and gain as high a slot as possible in the High Score file.
  25.  
  26.  
  27.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  28.          created in the directory you run the door from.
  29.  
  30.  
  31.  
  32.                               INSTALLATION
  33.                               ____________
  34.  
  35.  
  36.    Installation is fairly easy and straight-forward. The following steps and
  37.    examples should have you up and running in a very short period of time.
  38.    It is assumed that you are familiar with setting up DOORS on your system.
  39.    To this end, only examples of the configuration file and Door batch file
  40.    are described.
  41.  
  42.       1) Create a directory to hold all GROAN files
  43.  
  44.       2) Unzip GROANxx.ZIP into the the above directory
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied GROAN.CFG file. A description follows:
  48.  
  49.             **                       Location of system file (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First name
  52.  
  53.             Lawrence                 Sysop's Last Name
  54.  
  55. |-----------------------------------------------------------------------------|
  56. | READ!     1                        CommPort  \ These 2 lines are required   |
  57. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  58. |-----------------------------------------------------------------------------|
  59.  
  60.             00000000                 Registration Number
  61.  
  62.    !    #   5                        Maximum # of Turns per day
  63.                                      (Sysop gets 999 in Registered version)
  64.  
  65.         #   0                        Max # of days a caller can make up, during
  66.                                      calls in one day. 0=Disable Make-up Option
  67.                                      Maximum value = 27, Minimum value = 1
  68.  
  69.         #   NONE                     Drive:\Path\Filename to contain the
  70.                                      Top Score Bulletin or enter NONE
  71.                                      for NO Bulletin creation.
  72.  
  73.         #   NONE                     Drive:\Path\Filename to contain the
  74.                                      Top Score Bulletin (Color) or enter NONE
  75.                                      for NO Bulletin creation.
  76.  
  77.         #   NONE                     Drive:\Path\Filename to contain the
  78.                                      Hall of Fame Bulletin or enter NONE
  79.                                      for NO Bulletin creation.
  80.  
  81.         #   NONE                     Drive:\Path\Filename to contain the
  82.                                      Hall of Fame Bulletin (Color) or enter NONE
  83.                                      for NO Bulletin creation.
  84.  
  85.  
  86.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  87.                                      2 = Display ADOPT-A-DOOR message
  88.  
  89.         #   2                        Keyboard timeout value in Minutes
  90.  
  91.     !   #   0                        Time Allowed in Door
  92.                                      (Sysop = Time Remaining - REG. VERSION)
  93.  
  94.         #   N                        Automatic game reset at end of month:
  95.                                        Y = Yes enable autoreset
  96.                                        N = Keep accumulating scores
  97.  
  98.         #   Y                        Y = Allow Sysop to have 999 games
  99.                                      N = Do Not Allow Sysop 999 games
  100.  
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  108.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  109.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  110.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  111.  
  112.     @   #   XXXX/YYYY                 Blackout Range  From/To
  113.     @   #   XXXX/YYYY                 Blackout Range  From/To
  114.     @   #   XXXX/YYYY                 Blackout Range  From/To
  115.     @   #   XXXX/YYYY                 Blackout Range  From/To
  116.     @   #   XXXX/YYYY                 Blackout Range  From/To
  117.  
  118.           ** = Replace with ONE of the following:
  119.  
  120. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  121. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  122. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  123.                                    (Note:DOOR.SYS must be in SAME directory)
  124. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  125. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  126. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  127. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  128. C:\BBS\CHAIN.TXT                <- For WWIV systems
  129. C:\BBS\GTUSER.BBS               <- For GT Power
  130.                                    * if using this option you must put the
  131.                                      ComPort # on line 5 and the Node # on
  132.                                      line 6 of the configuration file
  133.  
  134.  
  135.            # = Requires registration to change to a different value.
  136.            ! = See "Plays Per Day/Door Time" Below
  137.            @ = See "Blackout Periods" Below
  138.  
  139.                NOTE: There are NO Blank Lines in the Config File!!
  140.  
  141.  
  142.       4) Create a batch file or modify the GROAN file supplied. A
  143.          description of this file follows:
  144.  
  145.             ECHO off
  146.             cd\BBS\DOORS\GROAN        Location of Groan files
  147.             GROAN GROAN.CFG           EXE filename and CFG filename (Name
  148.                                       used in creating file in #3 above)
  149.             CD\BBS
  150.             BOARD
  151.  
  152.  
  153.        5) When running in more than one node, be sure to supply a
  154.           different configuration name for each node (your choice of name).
  155.  
  156.        6) If running with Fossil-based multi-port boards add
  157.           /FD to the line containing the CFG name as follows:
  158.  
  159.                           GROAN GROAN.CFG /FD
  160.  
  161.  
  162.  
  163.                             JACKPOT Points
  164.                             --------------
  165.  
  166. When you end up losing points, Hiroll will place them into the "JACKPOT".
  167. This "JACKPOT" will continue to accumulate all points lost by any player.
  168. It will also accumulate the points lost by those playing on any other node(s)
  169. at the same time. The "JACKPOT" points will be updated on the players screen
  170. REAL TIME (at the moment the player on another node loses points). The
  171. "JACKPOT" points can be won by any player, if they roll three (3) JACKPOTS
  172. during any dice roll. Minimum amount in the "JACKPOT" will be 100 points.
  173.  
  174.  
  175.  
  176.                MAKE-UP DAYS (Registered version only)
  177.                --------------------------------------
  178.  
  179. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  180. during the current month and prior to the current call. You control whether
  181. to allow this option, as well as the number of days the caller can make up, on
  182. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  183. configuration file, turns the option OFF, any other value (up to a max of 27)
  184. turns the option ON and dictates the number of days the caller can make up.
  185.  
  186.  
  187. NOTE:      The number of games per day is calculated as follows...
  188.  
  189.            Games Allowed per day x Number of makeup days.
  190.  
  191. Example:   Games Allowed per day = 2
  192.            Max # of makeup days  = 4
  193.  
  194. If a caller logs in on 5/8/92 and this is their first call of the month, they
  195. would have a potential of 16 games to makeup and bring them current
  196. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  197. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  198. (games allowed * max # of makeup days).
  199.  
  200.  
  201.  
  202.              HALL OF FAME BULLETINS (Registered version only)
  203.              ------------------------------------------------
  204.  
  205. The program will automatically reset the game when the first caller of the
  206. month plays the game. The score file will be cleared and a set of Hall of Fame
  207. bulletin files will be created. The files will be called SUNHOF.ASC and
  208. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  209. directory as the GROAN.EXE file. You are responsible for COPYING the files to
  210. your bulletin area and renaming to a filename of your choice.
  211.  
  212. WARNING: The HOF files are cumulative files. That means they are read in each
  213.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  214.          the record of prior months winners!!!!
  215.  
  216.  
  217.  
  218.                           BLACKOUT PERIODS
  219.                           ________________
  220.  
  221.       Use the Blackout ranges option to define up to 5 time periods during
  222.       which you DO NOT want the Door to be played. If a caller tries to access
  223.       the Door during the Blackout period, they will be shown a message that
  224.       contains ALL the Blackout periods you have defined, and to try the Door
  225.       at a later time.
  226.  
  227.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  228.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  229.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  230.  
  231.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  232.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  233.                    a Blackout range.
  234.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  235.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  236.  
  237.  
  238.                           PLAYS Per DAY/DOOR Time
  239.                           _______________________
  240.  
  241.       Plays Per Day and Door Time can be controlled several ways:
  242.  
  243.       (1) You can use the Games Per Day, singular option, in the config
  244.           file above. This option, will affect ALL callers whose Security
  245.           Level is NOT defined in any of the 10 optional Security Level/
  246.           Plays Per Day entries in the config file.
  247.  
  248.       (2) You can use the Door Time, singular option, in the config file
  249.           above. This option, will affect ALL callers whose Security
  250.           Level is NOT defined in any of the 10 optional Security Level/
  251.           Plays Per Day/Door Time entries in the config file.
  252.  
  253.       (3) You can restrict the number of games a specific Security Level
  254.           will be allowed to play per day or REWARD specific Levels with
  255.           more Plays Per Day.
  256.  
  257.           Likewise, you can restrict the Play time for a specific Security
  258.           Level or REWARD specific Levels with more Door Time.
  259.  
  260.           These options are handled by the use of the 10 config
  261.           entries (000=00/00).
  262.  
  263.           The format of each entry is as follows:
  264.  
  265.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  266.                      where =  is a constant and MUST be included
  267.                      where YY is the # of games per day (must be 2 digits)
  268.                      where / is a constant and MUST be included
  269.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  270.  
  271.           If the callers Security Level is NOT defined, his/her Plays Per
  272.           Day and Door Time will be controlled by the values in items
  273.           (1) and (2), above, respectively..
  274.  
  275.           You may define up to 10 Security Levels. All unused entries must
  276.           be defined as   00=00/00
  277.         --------------------------------------------------------------------
  278.           Example: Suppose you had 3 Security Levels defined on your BBS as
  279.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  280.           wanted to set Plays Per Day as :     Subscriber=5
  281.                                            Visiting Sysop=2
  282.                                                   CoSysop=3
  283.                                                    Friend=10
  284.  
  285.           and Door Time as follows:     Subscriber=30 minutes
  286.                                     Visiting Sysop=20 minutes
  287.                                            CoSysop=10 minutes
  288.                                             Friend=remaining call time
  289.  
  290.  
  291.           You would set the Individual "Games per Day" config entry to 1 and
  292.           the individual "Door Time" to 5 minutes (these would be the
  293.           default number of games and default Time for all Security Levels
  294.           other than 20,30 or 40... make them any number you want). Next you
  295.           would replace 4 of the Security Level entries as :  020=05/30
  296.                                                               030=02/20
  297.                                                               040=03/10
  298.                                                               090=10/0
  299.  
  300.  
  301.  
  302.                         NON-STANDARD COM SUPPORT
  303.                         ________________________
  304.  
  305.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  306.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  307.       number after the configuration filename. Let's assume your Door is
  308.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  309.       passed to your Door would be:
  310.  
  311.                             FOOBAR FOOBAR.CFG /5
  312.  
  313.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  314.       normally used with COM1. No /x parameter is needed for the standard
  315.       IRQ's.
  316.  
  317.       As an alternative, you may use an environmental variable on the command
  318.       line. To use the variable (following the example above), place a
  319.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  320.       different IRQ number for each node). The command line would now look
  321.       like this:
  322.  
  323.                           FOOBAR FOOBAR.CFG /%IRQ%
  324.  
  325.       This, in combination with the use of the environmental variables
  326.       described in the MULTI-NODE SETUP section will allow you to use one
  327.       batch file and one config file to run this door on all nodes.
  328.  
  329.  
  330.  
  331.  
  332.                            MULTI-NODE SETUP
  333.                            ________________
  334.  
  335.       All Sunrise Doors are Multi-Node capable. Each node must have the
  336.       ability to access a configuration file which will have its own system
  337.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  338.       line. There are 2 ways to accomplish this:
  339.  
  340.       (1) Create a separate configuration file for each node. The only
  341.           difference between each file would be the location of the system
  342.           file for that particular node. For example, on my system there are 2
  343.           nodes and the first line of the config files would look like this:
  344.  
  345.                         NODE1:  H:\PCB1\DOOR.SYS
  346.                         NODE2:  H:\PCB2\DOOR.SYS
  347.  
  348.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  349.  
  350.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  351.           the following PCBoard environmental variables:
  352.  
  353.                  PCBDIR    (Directory containing the System file)
  354.                  PCBDRIVE  (Drive containing the System file)
  355.  
  356.           Thus, the first line of the SINGLE configuration file, for this Door
  357.           would look like this:
  358.  
  359.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  360.  
  361.       NOTE: This option, as described, assumes that you are running PCBoard
  362.             14.5a software. The environmental variables are automatically
  363.             created by the software for each node.
  364.  
  365.             HOWEVER, if you are running other BBS software you should be able
  366.             to set the variables EXACTLY as described below, for EACH node
  367.             (more than likely in each batch file you use to bring up EACH node):
  368.  
  369.                             PCBDRIVE=C:
  370.                             ^^^^^^^^^
  371.                             PCBDIR=\NODE2
  372.                             ^^^^^^^^
  373.  
  374.             Info with a carat (^) under it, MUST be typed as is. The rest
  375.             depends on your naming conventions.
  376.  
  377.             This, in combination with the use of the optional environmental
  378.             variable described in the NON-STANDARD COM SUPPORT section, will
  379.             allow you to use one batch file and one config file to run this
  380.             door on all nodes.
  381.  
  382.  
  383.                                ADOPT-A-DOOR
  384.                                ____________
  385.  
  386.     Having been a Sysop for a number of years, I have had my share of problems
  387.     and frustrations getting financial support for my board's upkeep. A fellow
  388.     Sysop left a message on my board, not long ago, about a concept that was
  389.     being used by several boards around the country.
  390.  
  391.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  392.     would be the same as sending in a donation, only this way it is earmarked
  393.     for registering a particular door. In a way, the user feels he/she is
  394.     "getting something in return". As a Door author I have decided to build
  395.     this concept into each of my Door programs. The concept replaces the
  396.     usual message "tell the Sysop to register this Door" we find in most
  397.     doors.
  398.  
  399.     If the Door is unregisterd then a message appears on the opening screen
  400.     to that effect. After finishing or suspending a game, a message screen
  401.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  402.     caller to contact the Sysop to find out if there is any further details
  403.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  404.     time, etc to callers that ADOPT-A-DOOR.
  405.  
  406.     If the Door has been registered, either by the Sysop or other callers,
  407.     the names of those contributors will be displayed in the closing screen.
  408.  
  409.     NOTE: If you want to display the names of the callers that contributed
  410.           to registering the Door, you must create an ASCII file called
  411.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  412.           the name(s) of the contributors (one on each line, maximum of 5
  413.           entries, each a maximum of 30 characters long). This file must be
  414.           saved, in ASCII format, and placed in the Door directory.
  415.  
  416.  
  417.  
  418.                               LEGALITIES
  419.                               __________
  420.  
  421.  
  422.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  423.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  424.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  425.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  426.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  427.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  428.       OR BREACH OF ANY WARRANTY.
  429.  
  430.  
  431.  
  432.  
  433.  
  434.                              DISTRIBUTION
  435.                              ____________
  436.  
  437.    You may make this file available for downloading from your BBS or you may
  438.    upload it to any BBS of your choice, provided that you do not make any
  439.    changes to the contents of the archive (ZIP file). The archive and its
  440.    individual contents may not be used by any service that charges any money
  441.    whatsoever, without the written permission of the author.
  442.  
  443.  
  444.  
  445.  
  446.  
  447.                              REGISTRATION
  448.                              ____________
  449.  
  450.    Registration and the subsequent insertion of the registration number into
  451.    your configuation file, allows for the display of your BBS name on the
  452.    opening and closing screen as well as the reduction of a delay built into
  453.    the opening screen display along with the ability to change certain
  454.    values in the configuration file.
  455.  
  456.    To register your copy of GROAN, please fill out the registration form
  457.    (REGISTER.FRM) and mail it along with the registration fee to
  458.    the name and address on the form.
  459.  
  460.    Be sure to use the proper upper/lower case when filling in your name and
  461.    BBS name, as they MUST match the way you entered them in the configuration
  462.    file.             ^^^^
  463.  
  464.    Based upon information supplied on the registration form, I will pre-
  465.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  466.    up your registration number.
  467.  
  468.  
  469.  
  470.                                  MISC
  471.                                  ____
  472.  
  473.    The latest version of GROAN DICE and other fine SUNRISE DOOR programs
  474.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  475.  
  476.    Remember, should you have any problems, questions or suggestions, be sure
  477.    to drop me a message on either of the aforementioned BBS', SmartNet (Sysops)
  478.    Rime (PCBhints, Common, Doors, Sysops) or FidoNet 1:133/410
  479.  
  480.